View source for Extension:VisualEditor/ja

<languages/>
{{Bundled|1.35}}
{{Extension
| image = VisualEditor-logo.svg
| name = 
| status = stable
| license = 
| type = 
| type1 = page action
| type2 = extended syntax
| type3 = beta feature
| type4 = skin
| description = <span lang="en" dir="ltr" class="mw-content-ltr">Allows for editing pages as rich content</span>
| author = 
| mediawiki = 
| download = {{WikimediaDownload|VisualEditor|phab=EVED}}
| needs-updatephp = No
| readme = [[git:mediawiki/extensions/VisualEditor/+/master/README.md|README]]
| help = {{ll|Help:VisualEditor/User guide}}
| phabricator = visualeditor
| version = continuous updates
| latest release date = 
| translate = ext-visualeditor-0-all
| vagrant-role = visualeditor
| compatibility policy = rel
}}
<span lang="en" dir="ltr" class="mw-content-ltr">The '''VisualEditor''' extension allows for editing pages as rich content.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">There is also a [[Special:MyLanguage/VisualEditor|project]] of the same name aiming to create a reliable rich-text editor for the Web and for MediaWiki.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Before MediaWiki 1.35, the VisualEditor extension relied on a separate {{ll|Parsoid}} parser service that needed to be installed and enabled in order to edit pages with it; this is now bundled with MediaWiki core.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For documentation specific to this old Parsoid service, see [[Special:PermanentLink/4040509|this old version of the page]].</span>

__TOC__
== 利用者ガイド ==

{{ll|Help:VisualEditor/User guide}} を参照してください。

== ダウンロード ==

<div lang="en" dir="ltr" class="mw-content-ltr">
=== For the general user ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you're using the latest stable version of MediaWiki, you will not need to download the VisualEditor extension from [[Special:ExtensionDistributor/VisualEditor]] as it already comes with the MediaWiki tarball.
</div>  

<div lang="en" dir="ltr" class="mw-content-ltr">
=== If you are using Git ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The following download instructions are for use with the '''latest nightly build of MediaWiki only'''.
</div> 

<syntaxhighlight lang="bash">
cd extensions
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor.git
cd VisualEditor
git submodule update --init
</syntaxhighlight>

{{note|1=
* <span lang="en" dir="ltr" class="mw-content-ltr">VisualEditor’s master branch contains the latest code, as used at Wikimedia.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This code is potentially slightly buggy or unstable, but is likely to have fewer bugs and more features than old builds.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">'''The master branch requires alpha builds of MediaWiki''' and will not work with the older, official releases of MediaWiki like {{MW legacy lts branch number}}; for that, use the <code>{{MW legacy lts release git}}</code> branch (command: <code>git clone -b {{MW legacy lts release git}} <nowiki>https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor.git</nowiki></code>).</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">The <code>git submodule update --init</code> command is vital, as VisualEditor MediaWiki extension needs the core VisualEditor submodule to work.</span> '''<span lang="en" dir="ltr" class="mw-content-ltr">If you do not use this command, VisualEditor will fail to work.</span>'''
* <span lang="en" dir="ltr" class="mw-content-ltr">See {{§ll|Parsoid|Development}} for details on linking an alpha build of the Parsoid library up to VisualEditor; the latest version of VisualEditor '''will''' need a development version of Parsoid as well.</span>  '''<span lang="en" dir="ltr" class="mw-content-ltr">You must follow the instructions on the {{ll|Parsoid}} page to configure Parsoid if you are installing VisualEditor from git, or using an alpha release of 1.36!</span>''' <span lang="en" dir="ltr" class="mw-content-ltr">If you do not, VisualEditor will fail to work.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">It is recommended to use PHP 7.3 or later, as [[phab:T230861|Parsoid uses less memory on newer versions of PHP]].</span> <span lang="en" dir="ltr" class="mw-content-ltr">This is not a hard requirement; WMF still runs PHP 7.2 in production.</span>
}}

== インストール ==

<div lang="en" dir="ltr" class="mw-content-ltr">
VisualEditor needs to be installed with:
</div>

<syntaxhighlight lang="php">
wfLoadExtension( 'VisualEditor' );
</syntaxhighlight>

== 外装の互換性 ===

<div lang="en" dir="ltr" class="mw-content-ltr">
VisualEditor is known to be compatible with the following skins:
</div>

* {{ll|Skin:Vector|nsp=0}}
* {{ll|Skin:MonoBook|nsp=0}}
* {{ll|Skin:Apex|nsp=0}}
* {{ll|Skin:Poncho|nsp=0}}
* {{ll|Skin:Minerva Neue|nsp=0}}
* {{ll|Skin:Cosmos|nsp=0}}
* <span lang="en" dir="ltr" class="mw-content-ltr">Minerva (was part of {{ll|Extension:MobileFrontend|nsp=0}})</span>
* {{ll|Skin:Modern|nsp=0}} {{MW version-inline|1.35+}}
* {{ll|Skin:Medik|nsp=0}}
* {{ll|Skin:Citizen|nsp=0}}

<span lang="en" dir="ltr" class="mw-content-ltr">Other skins are not officially supported, but it should be compatible with any skin that uses the required HTML structure</span>
'''{{ll|Extension:VisualEditor/Skin requirements}}''' を参照してください。
<span lang="en" dir="ltr" class="mw-content-ltr">Some fiddling with skin stylesheets might be necessary to make everything look nice.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It will load on any skin if it matches the feature detection.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Setting up VisualEditor ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Installing Parsoid ===
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Before MediaWiki 1.35, it was necessary to set up the {{ll|Parsoid}} Node.js service before you could edit or save pages; see {{§ll|Parsoid/JS|Setting up VisualEditor}} for documentation.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This is not necessary for MediaWiki 1.35 and later, unless you are running a pre-release version of VisualEditor from git (see notes above).</span> 

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Basic configuration for VisualEditor ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Basic operation of VisualEditor in MediaWiki 1.35 and later does not require any manual configuration.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
For users of earlier versions, or those with special needs, the following are the most-frequent customizations.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Short URLs on Apache (MW ≥ 1.35.x) ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you are using VisualEditor for MediaWiki 1.35 and later with non-standard short URLs as <nowiki>"https://wiki.example.org/Page_title"</nowiki> on Apache you need to adapt the rewrite rules of the [[Special:MyLanguage/Extension:VisualEditor/webserver|webserver]].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Enabling the write API ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">The user groups who should be able to use VisualEditor must have access to the MediaWiki write API.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">{{ll|Manual:$wgGroupPermissions|$wgGroupPermissions}} needs to be set accordingly, e.g. for the user group named ''user'' this is done with:</span>

<syntaxhighlight lang="php">
$wgGroupPermissions['user']['writeapi'] = true;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Linking with Parsoid ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">By default, VisualEditor is automatically configured to talk to a Parsoid service running on the same host.</span>
'''<span lang="en" dir="ltr" class="mw-content-ltr">You should not need to change this in most cases!</span>'''
<span lang="en" dir="ltr" class="mw-content-ltr">Advanced configurations may wish to run Parsoid on a dedicated host or cluster.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If you need to do this, add the following code to your <code>LocalSettings.php</code> to specify your non-local Parsoid instance:</span>

<syntaxhighlight lang="php">
$wgVirtualRestConfig['modules']['parsoid'] = array(
    // URL to the Parsoid instance
    // You should change $wgServer to match the non-local host running Parsoid
    'url' => $wgServer . $wgScriptPath . '/rest.php',
    // Parsoid "domain", see below (optional, rarely needed)
    // 'domain' => 'localhost',
);
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Parsoid's <code>domain</code> setting here must match the host portion of {{phpi|$wgServer}} on the host running the Parsoid service.
</div>

'''<span lang="en" dir="ltr" class="mw-content-ltr">If you set <syntaxhighlight lang=php inline>$wgVirtualRestConfig['modules']['parsoid']</syntaxhighlight>, then you will also need to manually install Parsoid.</span>'''
<span lang="en" dir="ltr" class="mw-content-ltr">Either on a separate server or via [[Special:MyLanguage/Parsoid#Linking a developer checkout of Parsoid|the developer instructions on the Parsoid page]].</span>

<span lang="en" dir="ltr" class="mw-content-ltr">''Note for developers:'' as noted above, in development releases '''including 1.36-alpha''' Parsoid will need to be manually loaded.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This will change before 1.36 is released.</span> <span lang="en" dir="ltr" class="mw-content-ltr">'''If you are running a development release, you should follow the instructions in {{§ll|Parsoid|Development}}''' at the very least add the following to your <code>LocalSettings.php</code>:</span>

<syntaxhighlight lang="php">
// For 1.36-alpha only
wfLoadExtension( 'Parsoid', 'vendor/wikimedia/parsoid/extension.json' );
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Allowing VisualEditor on page titles containing slashes ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you are serving MediaWiki from apache2, you will need to add the following to your top level server configuration (often a <code>&lt;VirtualHost></code> section in <code>/etc/apache2/site-enabled/000-default.conf</code> or similar):
</div>

<syntaxhighlight lang="apacheconf">
AllowEncodedSlashes NoDecode
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">If you do not, then VisualEditor will complain that "{{int|visualeditor-loaderror-revidconflict|''revision ID''|''revision ID''}}" or simply "{{int|apierror-visualeditor-docserver-http|404}}" when editing a page title containing a slash, for example a subpage.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See {{T|268953}} and the [https://httpd.apache.org/docs/2.4/mod/core.html#allowencodedslashes Apache documentation] for more information.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
If the Apache server happens to be behind a Nginx proxy, then its <code>proxy_pass</code> stanza should make use of the {{phpi|$request_uri}} parameter (cf. [https://stackoverflow.com/a/20514632 discussion] on StackOverflow).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Activating VisualEditor by default ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Before MediaWiki 1.35, VisualEditor did not enable itself for users by default.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">To make it available, add the following lines to your wiki's <code>LocalSettings.php</code> after you have downloaded the extension.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This is not necessary for MediaWiki 1.35 and later.</span>

<syntaxhighlight lang="php">
// MediaWiki <= 1.34: Enable by default for everybody
$wgDefaultUserOptions['visualeditor-enable'] = 1;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
The following optional configurations can also be used:
</div>

<syntaxhighlight lang="php">
// Optional: Set VisualEditor as the default editor for anonymous users
// otherwise they will have to switch to VisualEditor
$wgDefaultUserOptions['visualeditor-editor'] = "visualeditor";

// Optional: Don't allow users to disable it
$wgHiddenPrefs[] = 'visualeditor-enable';

// Optional: Enable VisualEditor's experimental code features
$wgDefaultUserOptions['visualeditor-enable-experimental'] = 1;

// Activate ONLY the 2017 wikitext editor by default

$wgDefaultUserOptions['visualeditor-autodisable'] = true;
$wgDefaultUserOptions['visualeditor-newwikitext'] = 1;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Other extensions which load plugins for VisualEditor can be loaded before or after VE if you are using MediaWiki 1.25 or later; the plugins should work either way.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Changing active namespaces ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">By default, VisualEditor is only enabled for the namespaces "{{ns:Main}}", "{{ns:User}}", "{{ns:File}}" and "{{ns:Category}}".</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It is however possible to add or remove namespace using the English language canonical names defined for the respective namespaces such as e.g. "Project", "Talk", etc.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Additional custom namespaces use the names used to create them.</span>

<syntaxhighlight lang="php">
// Enable for the meta namespace, disable for the "File" namespace and enable for the "Extra", the latter being a custom namespace
$wgVisualEditorAvailableNamespaces = [
    'Project' => true,
    'File' => false,
    'Extra' => true
];
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Switching between wikitext and visual editing ====
</div>
{{warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">Do not install RESTBase on a private wiki! RESTBase currently cannot be configured to keep page content private but will make all pages content publicly accessible.</span> <span lang="en" dir="ltr" class="mw-content-ltr">More details can be found at {{T|88016}}.</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
VisualEditor allows you to switch back and forth between wikitext and visual editing.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">However, without a {{ll|RESTBase}} server, switching from wikitext to visual editing may result in ''dirty diffs'' when saving (non-semantic whitespace changes to wikitext formatting).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If you want the ability to switch between wikitext editing and VisualEditor and save your changes without dirty diffs, you must install a RESTBase server</span>. 

<div lang="en" dir="ltr" class="mw-content-ltr">
If you can't set up RESTBase and dirty diffs are undesirable on your wiki (e.g. your users carefully review all changes), you can disable this feature using <syntaxhighlight lang=php inline>$wgVisualEditorAllowLossySwitching=false</syntaxhighlight>.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">When switching isn't possible and you try to switch from a wikitext editing environment into VisualEditor, your only options are "{{int|visualeditor-mweditmodesource-warning-cancel}}" or "{{int|visualeditor-mweditmodesource-warning-switch-discard}}"; any changes you made will be discarded if you switch.</span><ref>
[[mailarchive:wikitech-l/2017-February/087635.html]]</ref>

<div lang="en" dir="ltr" class="mw-content-ltr">
===== RESTBase setup for switching =====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To set up your own RESTBase service, follow the [[Special:MyLanguage/RESTBase/Installation|RESTBase installation instructions]], paying special attention to the Parsoid configuration.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Once the RESTBase server is operational, add the following code to your <code>LocalSettings.php</code>:
</div>

<syntaxhighlight lang="php">
$wgVisualEditorParsoidAutoConfig = false;

$wgVirtualRestConfig['modules']['restbase'] = [
  'url' => "http://yourRESTBaseserver.com:7231",
  'domain' => '{domain}',
  'parsoidCompat' => false
];

$wgVisualEditorFullRestbaseURL = 'http://yourRESTBaseserver.com:7231/{domain}/';
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">where <code>{domain}</code> is the value of the host portion of {{phpi|$wgServer}} on the host running Parsoid.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Make sure that the port you specify here (e.g. <code>:7231</code>) is the same port as you specified in the RESTBase configuration.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Be careful to include the trailing slash on {{phpi|$wgVisualEditorFullRestbaseURL}}!</span>

<span lang="en" dir="ltr" class="mw-content-ltr">If you can't access RESTBase port (e.g. <code>:7231</code>), you can work around the problem using an httpd proxy; refer to "[[Special:MyLanguage/RESTBase/Installation#If Restbase Port is blocked|if RESTBase port is blocked]]".</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If your wiki is served through HTTPS, RESTBase must also be served through HTTPS; else users could experience "mixed-content" errors and the switch from wikitext to VisualEditor would not work.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Now when you make changes in a wikitext editor, you can switch to VisualEditor without causing dirty diffs.
</div>

{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">In case you are serving your wiki over HTTPS, a standard procedure nowadays, you must serve RESTbase via HTTPS [[Special:MyLanguage/Extension:VisualEditor#Parsoid over HTTPS|similarily to Parsoid]] too to avoid [[Topic:Tzq4rg7ixacs2jdr|mixed content errors]].</span> <span lang="en" dir="ltr" class="mw-content-ltr">A concise and easy to understand discussion is available [[Topic:Tm2qsg4ywsykmahr|here]].</span> <span lang="en" dir="ltr" class="mw-content-ltr">Do not forget to mix in the following [[Special:MyLanguage/RESTBase/Installation#RESTBase Server|documentation]].</span> <span lang="en" dir="ltr" class="mw-content-ltr">Remember also to not forget to adapt your port numbers when using stunnel.</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Servers with multiple virtual sites ====
</div>
{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">Parsoid is served in production using {{ll|Extension:MediaWikiFarm}}.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Running Parsoid on multiple virtual sites using other mechanisms is untested; the instructions below were updated for MW 1.35 but have not been tested.</span>}}

<span lang="en" dir="ltr" class="mw-content-ltr">If Apache2 is configured with multiple virtual sites, Parsoid is (in standard configuration) only able to access the default site.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">To check for this problem, run <code>curl '<nowiki>[http://your-wiki-base-url</nowiki>]/rest.php/v1/page/Main_Page'</code> on the server, or run <code>curl '<nowiki>[https://your-wiki-base-url</nowiki>]/rest.php/v1/page/Main_Page'</code> ensuring the URL matches the SSL certificate used on the server.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
If the response contains the main page of your wiki then you don't have the problem, but if it doesn't, you may need to configure a host alias that Parsoid can use:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Look at the apache2 configuration file for the virtual server hosting the wiki, near the top of the file there should be a line like:
</div>

<blockquote>
<code><nowiki><VirtualHost *:80></nowiki></code>
</blockquote>

<span lang="en" dir="ltr" class="mw-content-ltr">If the "*" is present, then the alias can be to localhost, if there is an IP address replacing the "*" then the alias must be to that IP address.</span>  
<span lang="en" dir="ltr" class="mw-content-ltr">In the same file add a line:</span> <blockquote><code>ServerAlias my_wiki_alias</code></blockquote>

<div lang="en" dir="ltr" class="mw-content-ltr">
In the hosts file of the server (<code>/etc/hosts</code> on Ubuntu), add a route for <code>my_wiki_alias</code>, either for <code>127.0.0.1</code> (if the apache2 virtual server configuration had the "*" above, else to the IP address from the Apache2 virtual server configuration.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Now set the hostname in {{phpi|$wgServer}} to <code>my_wiki_alias</code> on the host running VisualEditor.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Linking with Parsoid in private wikis ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
In a private wiki, you should do this:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
===== Forwarding cookies to Parsoid =====
</div>
{{Warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">ONLY enable this on private wikis served over HTTP and ONLY IF you understand the SECURITY IMPLICATIONS of sending Cookie headers to Parsoid over HTTP!</span>}}
<div lang="en" dir="ltr" class="mw-content-ltr">
This is the default configuration for VisualEditor if [[gerrit:q/I0b958e8b75c04e4a27f50f91276be221a5b1404d|not everyone is allowed to read every page]], as such '''the below should not be required in most cases'''.
</div>

<syntaxhighlight lang="php">
// Forward users' Cookie: headers to Parsoid. Required for private wikis (login required to read).
// If the wiki is not private (i.e. $wgGroupPermissions['*']['read'] is true), this configuration variable will be ignored.
//
// WARNING: ONLY enable this on private wikis and ONLY IF you understand the SECURITY IMPLICATIONS of sending Cookie headers to Parsoid over HTTP.
$wgVirtualRestConfig['modules']['parsoid']['forwardCookies'] = true;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you do set any property in <syntaxhighlight lang=php inline>$wgVirtualRestConfig['modules']['parsoid']</syntaxhighlight>, '''you will have to [[Special:MyLanguage/Parsoid#Linking a developer checkout of Parsoid|manually install Parsoid]] or VisualEditor will not work!'''
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Quick configuration guide ===
</div>
{| class="wikitable"
! <span lang="en" dir="ltr" class="mw-content-ltr">Feature</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Beta Features opt-in state</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Enabled for all to opt-in</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Enabled for all to opt-out</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Enabled for all without opt-out</span>
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">Visual mode</span>
| 1.36+:<syntaxhighlight lang="php">
$wgVisualEditorEnableBetaFeature = true;
</syntaxhighlight><1.36:

''<span lang="en" dir="ltr" class="mw-content-ltr">Beta Feature shown by default; disable using:</span>''<syntaxhighlight lang="php">
$wgHiddenPrefs[] = 'visualeditor-enable';
</syntaxhighlight>
| <syntaxhighlight lang="php">
$wgDefaultUserOptions['visualeditor-autodisable'] = true;
</syntaxhighlight>
| 1.35+:

''<span lang="en" dir="ltr" class="mw-content-ltr">Enabled by default</span>''

<1.35:<syntaxhighlight lang="php">
$wgDefaultUserOptions['visualeditor-enable'] = 1;
</syntaxhighlight>
| ''<span lang="en" dir="ltr" class="mw-content-ltr">As in "Enabled for all to opt-out" plus:</span>''<syntaxhighlight lang="php">
$wgHiddenPrefs[] = 'visualeditor-enable';
</syntaxhighlight>
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">Wikitext mode</span>
| <syntaxhighlight lang="php">
$wgVisualEditorEnableWikitextBetaFeature = true;
</syntaxhighlight>
| <syntaxhighlight lang="php">
$wgVisualEditorEnableWikitext = true;
</syntaxhighlight>
| <syntaxhighlight lang="php">
$wgVisualEditorEnableWikitext = true;
$wgDefaultUserOptions['visualeditor-newwikitext'] = 1;
</syntaxhighlight>
| ''<span lang="en" dir="ltr" class="mw-content-ltr">As in "Enabled for all to opt-out" plus:</span>''<syntaxhighlight lang="php">
$wgHiddenPrefs[] = 'visualeditor-newwikitext';
</syntaxhighlight>
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">Single edit tab</span>
| ''<span lang="en" dir="ltr" class="mw-content-ltr">Not a supported configuration.</span>''
| <syntaxhighlight lang="php">
$wgVisualEditorUseSingleEditTab = true;
$wgDefaultUserOptions['visualeditor-tabs'] = 'multi-tab';
</syntaxhighlight>
| <syntaxhighlight lang="php">
$wgVisualEditorUseSingleEditTab = true;
</syntaxhighlight><span lang="en" dir="ltr" class="mw-content-ltr">Default edit tab behaviour will be to remember the last editor, and open with the wikitext editor for first edit; if you want it to be the visual editor, also add:</span><syntaxhighlight lang="php">
$wgDefaultUserOptions['visualeditor-editor'] = 'visualeditor';
</syntaxhighlight>
| ''<span lang="en" dir="ltr" class="mw-content-ltr">As in "Enabled for all to opt-out" plus:</span>''<syntaxhighlight lang="php">
$wgHiddenPrefs[] = 'visualeditor-tabs';
</syntaxhighlight>
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">Visual diffs on history pages</span>
| <syntaxhighlight lang="php">
$wgVisualEditorEnableDiffPageBetaFeature = true;
</syntaxhighlight>
| ''<span lang="en" dir="ltr" class="mw-content-ltr">Not a supported configuration.</span>''
| ''<span lang="en" dir="ltr" class="mw-content-ltr">Not a supported configuration.</span>''
| <syntaxhighlight lang="php">
$wgVisualEditorEnableDiffPage = true;
</syntaxhighlight>
|}
<div lang="en" dir="ltr" class="mw-content-ltr">
== Complete list of configuration options ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Each configuration option is shown without the {{phpi|$wgVisualEditor}} prefix for brevity; replace the '…' when using.
</div>
{| class="wikitable"
! <span lang="en" dir="ltr" class="mw-content-ltr">Option</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Default value</span><!-- As of MW1.30.0-wmf2 -->
! <span lang="en" dir="ltr" class="mw-content-ltr">Useful for…</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Documentation</span>
|-
| <code>…PluginModules</code>
| <syntaxhighlight lang="json">
[]
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Extension developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Array of ResourceLoader module names (strings) that should be loaded when VisualEditor is loaded.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Other extensions that extend VisualEditor should add to this array.</span>
{{Warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">When removing a module on a production site (''e.g.'' Wikimedia), first remove it from this array, wait for the change to propagate, and only then remove the module code and module registration.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Otherwise there may be a period of time during which VisualEditor depends on a module that no longer exists.</span>}}
|-
| <code>…PreloadModules</code>
| <syntaxhighlight lang="json">
[
    "site",
    "user"
]
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Extension developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Array of ResourceLoader module names (strings) that should be loaded before VisualEditor is loaded.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Other extensions that extend VisualEditor and need to set up their environment before loading should add to this array.</span>
{{Warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">When removing a module on a production site (''e.g.'' Wikimedia), first remove it from this array, wait for the change to propagate, and only then remove the module code and module registration.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Otherwise there may be a period of time during which VisualEditor depends on a module that no longer exists.</span>}}
|-
| <code>…PreferenceModules</code>
| <syntaxhighlight lang="json">
{
	"visualeditor-enable-experimental": "ext.visualEditor.experimental"
}
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Extension developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Associative array of ResourceLoader module names (strings) that should be loaded when VisualEditor is loaded if the current user has a preference set.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Other extensions that extend VisualEditor should add to this array if they want their addition to be opt-in or opt-out.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Keys are preference names, values are ResourceLoader module names.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Remember to also set defaults in {{phpi|$wgDefaultUserOptions}}!
</div>
|-
| <code>…ParsoidAutoConfig</code>
| <syntaxhighlight lang="json">true</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Enables auto-configuration of the bundled version of the Parsoid REST API.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Set to <code>false</code> if you have an unusual Parsoid configuration and want to manually configure it.</span>
|-
| <code>…RestbaseURL</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">URL to use to access the main RESTbase call.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The page name will be appended directly to this value, so this needs to be set to something like '<code>https://en.wikipedia.org/api/rest_v1/page/html/</code>' <u>including</u> the trailing slash.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">If this is set, the page HTML will be requested from RESTbase.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If this is not set, the page HTML will be requested from the API, which will send an HTTP request to Parsoid or to RESTbase if available.</span>
|-
| <code>…FullRestbaseURL</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">URL to use to access the rest of RESTbase.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The page name will be appended directly to this value, so this needs to be set to something like '<code>https://en.wikipedia.org/api/rest_</code>' <u>excluding</u> the trailing slash.</span>
|-
| <code>…AllowLossySwitching</code>
| <syntaxhighlight lang="json">true</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to allow switching from wikitext to visual editor even if doing so may cause dirty diffs.</span>
|-
| <code>…SerializationCacheTimeout</code>
| <syntaxhighlight lang="json">3600</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Serialization cache timeout, in seconds.</span>
|-
| <code>…AvailableNamespaces</code>
| <syntaxhighlight lang="php">
[
    "User" => true,
    "File" => true,
    "Category" => true,
    "_merge_strategy" => "array_plus"
]
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Namespaces in which to enable VisualEditor (mapped from namespace canonical name to a boolean flag), on top of {{phpi|$wgContentNamespaces}}.</span>
|-
| <code>…AvailableContentModels</code>
| <syntaxhighlight lang="php">
[
    "wikitext" => "article",
    "_merge_strategy" => "array_plus"
]
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Extension developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Content models in which to enable VisualEditor (mapped from content model name to a boolean flag).</span>
|-
| <code>…UseChangeTagging</code>
| <syntaxhighlight lang="json">true</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to put a [[Special:MyLanguage/Manual:Tags|change tag]] on every edit made with VisualEditor.</span>
|-
| [[#Integration of "2017 wikitext editor"|<code>…EnableWikitext</code>]]
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to enable the [[Special:MyLanguage/2017 wikitext editor|wikitext source mode]] inside VisualEditor.</span>
|-
| <code>…EnableDiffPage</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to enable the [[Special:MyLanguage/VisualEditor/Diffs|visual diff]] function on the history special page.</span>
|-
| <code>…EnableDiffPageBetaFeature</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to allow users to enable the [[Special:MyLanguage/VisualEditor/Diffs|visual diff]] function on the history special page as a beta feature.</span>
|-
| <code>…EnableVisualSectionEditing</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to allow users to enable the section editing.</span>
|-
| <code>…UseSingleEditTab</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to use only one edit tab, switching back and forth, or add a dedicated VisualEditor edit tab next to the existing one.</span>
|-
| <code>…SingleEditTabSwitchTime</code>
| <syntaxhighlight lang="json">20160101000000</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">From what timestamp to warn existing editors that the installation has switched from two edit tabs to one.</span> <span lang="en" dir="ltr" class="mw-content-ltr">In general you should ignore this.</span>
|-
| <code>…TabPosition</code>
| <syntaxhighlight lang="json">'before'</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">If showing two edit tabs, where to put the VisualEditor edit tab in relation to the system (or WikiEditor) one:</span>
* 'before' - <span lang="en" dir="ltr" class="mw-content-ltr">put it right before the old edit tab</span>
* 'after' - <span lang="en" dir="ltr" class="mw-content-ltr">put it right after the old edit tab</span>
|-
| <code>…TabMessages</code>
| <syntaxhighlight lang="json">
{
	"edit": null,
	"editsource": "visualeditor-ca-editsource",
	"create": null,
	"createsource": "visualeditor-ca-createsource",
	"editlocaldescriptionsource": "visualeditor-ca-editlocaldescriptionsource",
	"createlocaldescriptionsource": "visualeditor-ca-createlocaldescriptionsource",
	"editsection": null,
	"editsectionsource": "visualeditor-ca-editsource-section"
}
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Configuration of what messages to use for the various kinds of edit tab users can see, if showing two edit tabs:</span>

''''edit'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the VisualEditor edit tab; if <code>null</code>, the default edit tab caption will be used; the '<code>visualeditor-ca-ve-edit</code>' message is available for this.</span>

''''editsource'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the old edit tab; if <code>null</code>, the tab's caption will not be changed.</span>

''''create'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the VisualEditor create tab; if <code>null</code>, the default create tab caption will be used; the '<code>visualeditor-ca-ve-create</code>' message is available for this.</span>

''''createsource'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the old create tab; if <code>null</code>, the tab's caption will not be changed.</span>

''''editlocaldescriptionsource'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the old edit tab on pages for files in foreign repos; if <code>null</code>, tab's caption will not be changed.</span>

''''createlocaldescriptionsource'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the old create tab on pages for files in foreign repos; if <code>null</code>, tab's caption will not be changed.</span>

''''editsection'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the VisualEditor section edit link; if <code>null</code>, the default edit section link caption will be used.</span>

''''editsectionsource'''<nowiki/>' – <span lang="en" dir="ltr" class="mw-content-ltr">i18n message key to use for the source section edit link; if <code>null</code>, the link's caption will not be changed.</span>
|-
| <code>…AutoAccountEnable</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to enable VisualEditor for every new account.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">This allows you to keep the '<code>visualeditor-enable</code>' preference disabled by default, but still have VisualEditor available for new logged-in users (by setting this to <code>true</code>).</span>
|-
| <code>…DisableForAnons</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to disable VisualEditor for non-logged-in users.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">This allows you to enable the '<code>visualeditor-enable</code>' preference by default, but still disable VisualEditor for logged-out users (by setting this to <code>true</code>).</span>
|-
| <code>…TransitionDefault</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">For wikis planning to use the '<code>visualeditor-betatempdisable</code>1' preference to auto-opt-out existing users whilst enabling by default for all existing users, whether to start recording explicit opt-outs against implicit ones.</span>
|-
| <code>…ShowBetaWelcome</code>
| <syntaxhighlight lang="json">true</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to show the "welcome to the beta" dialog the first time a user uses VisualEditor.</span>
|-
| <code>…NewAccountEnableProportion</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators running user analytics</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to enable VisualEditor for a proportion (Egyptian fraction) of all new accounts based on userID.</span>
|-
| <code>…FeedbackTitle</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to enable the MediaWiki feedback tool inside the help menu of VisualEditor.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If enabled, the title of the page at which to point the MediaWiki feedback tool.</span>
|-
| <code>…FeedbackAPIURL</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">System administrators</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">If set, the API of the remote wiki at which to point the MediaWiki feedback tool.</span>
|-
| <code>…SkinToolbarScrollOffset</code>
| <syntaxhighlight lang="json">
[]
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">Skin developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">An array of skin names mapped to pixel values to which to set the toolbar scroll offsets.</span>
|-
| 1.35+:
<code>…BrowserUnsupportedList</code>

<1.35:

<code>…BrowserBlacklist</code>
| <syntaxhighlight lang="json">
{
	"firefox": [
		[
			"<=",
			11
		]
	],
	"safari": [
		[
			"<=",
			6
		]
	],
	"opera": [
		[
			"<",
			12
		]
	]
}
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">VisualEditor developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">List of browsers with which VisualEditor is incompatible.</span> 仕様は <code>jquery.Client</code> を参照してください。 <span lang="en" dir="ltr" class="mw-content-ltr">If the user's browser is matched, VisualEditor will refuse to load.</span>

'''Firefox''' – <span lang="en" dir="ltr" class="mw-content-ltr">There is a wikilink corruption (<code><nowiki>[[./]]</nowiki></code>) bug in Firefox 14 and below ({{T|52720}}) which prevent wider availability.</span>

'''Safari''' – <span lang="en" dir="ltr" class="mw-content-ltr">Older versions of Safari suffered from corruption issues from various old browser plugins.</span>

'''Opera''' – <span lang="en" dir="ltr" class="mw-content-ltr">Below version 12, Opera was untested, and as its user base is almost non-existent anyway it's blocked.</span>

'''Internet Explorer''' – <span lang="en" dir="ltr" class="mw-content-ltr">At or below version 9, there are various incompatibilities in layout and feature support.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Versions 10 and 11 should work correctly.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Not listed independently, because it's inherited from MediaWiki itself, '''Android''' at 3.x and below support CE but don't trigger keyboard input or have other issues, making it useless for users.</span>
|-
| <code>…EnableTocWidget</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">VisualEditor developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">Whether to enable the (currently experimental) Table of Contents widget.</span>
|-
| <code>…RebaserURL</code>
| <syntaxhighlight lang="json">false</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">VisualEditor developers</span>
| <span lang="en" dir="ltr" class="mw-content-ltr">URL to use to access the experimental rebaser technology.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If <code>false</code>, the technology isn't loaded.</span>
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Old configuration parameters ===
</div>
{{Warning|1=<span lang="en" dir="ltr" class="mw-content-ltr">These parameters are no longer used in recent versions of VisualEditor; they are documented here for compatibility purposes with the proposed upgrade paths.</span>}}
<div lang="en" dir="ltr" class="mw-content-ltr">
As above, each configuration option is shown without the {{phpi|$wgVisualEditor}} prefix for brevity.
</div>
{| class="wikitable"
|-
! <span lang="en" dir="ltr" class="mw-content-ltr">Option</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">MW versions</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Default value</span>
! <span lang="en" dir="ltr" class="mw-content-ltr">Documentation</span>
|-
| <code>…Namespaces</code>
| 1.22–1.25
|
* 1.22 (PHP config) - <syntaxhighlight lang="php">$wgContentNamespaces</syntaxhighlight>
* 1.23-1.25 (PHP config) - <syntaxhighlight lang="php">array_merge( $wgContentNamespaces, array( NS_USER ) )</syntaxhighlight>
* 1.25 (extension.json) - <syntaxhighlight lang="json">[]</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">List of namespaces IDs where is the VisualEditor is activated.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">This parameter has been essentially replaced by <code>…AvailableNamespaces</code> from 1.26.</span>
|-
| <code>…SupportedSkins</code>
| 1.22–1.28
| <syntaxhighlight lang="json">
[
	"vector",
	"apex",
	"monobook",
	"minerva",
	"blueprint"
]
</syntaxhighlight>
| <span lang="en" dir="ltr" class="mw-content-ltr">List of skins VisualEditor integration supports.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If the user's skin is not matched, VisualEditor will refuse to load.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">This is replaced by a dynamical check of the requirements ({{T|161373}}).</span>
|}

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Related configuration parameters ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
See also {{§ll|Upload dialog|Configuration (for wiki sysadmins)}} for information about configuring the drag-and-drop/copy&paste functionality for uploading media files through VisualEditor.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Integration of "2017 wikitext editor" ==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Since release branch "REL1_29" (MediaWiki 1.29 and later) it is also possible to activate the so called ''"2017 wikitext editor"''.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">To enable it, follow the instructions for '''wikitext mode''' in the [[#Quick configuration guide|Quick configuration guide]].</span>

; <span lang="en" dir="ltr" class="mw-content-ltr">Enabling wikitext syntax highlighting</span> :
<span lang="en" dir="ltr" class="mw-content-ltr">It is also possible to enable wikitext syntax highlighting for the "2017 wikitext editor".</span>
<span lang="en" dir="ltr" class="mw-content-ltr">To do this you have to additionally install the {{ll|Extension:CodeMirror}} extension.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Rich template forms ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{{ll|Extension:TemplateData}} allows the addition of template information, making templates easier to insert with the VisualEditor.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Improved citation tool ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Citations can be improved by configuring the [[Special:MyLanguage/VisualEditor/Citation tool|citation tool]], and also by setting up {{ll|Citoid}}.
</div>

== トラブルシューティング ==
; <span lang="en" dir="ltr" class="mw-content-ltr">All templates appear as puzzle icons instead of displaying its contents</span>
: [[Topic:V6tbh7vonvg3mzl9]] を参照してください。

; Docker<nowiki>:</nowiki> {{int|apierror-visualeditor-docserver-http-error|curl error<nowiki>:</nowiki> 7}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Ensure that the MediaWiki container name does not equal to the domain the wiki is running on.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If both names are equal, the api will try to connect to the domain the wiki is running on, but only receive the local ip of the container.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This will cause errors when <code>ssl</code> is enabled.</span>

; {{int|apierror-visualeditor-docserver-http-error|http-bad-status}}}
:* <span lang="en" dir="ltr" class="mw-content-ltr">When editing subpages on Apache, <code>AllowEncodedSlashes NoDecode</code> must be added in the VirtualHost section of the wiki ({{T|268953}}).</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">On a private wiki, see "''parsoidserver-http-bad-status<nowiki>:</nowiki> 401''" below.</span>

; {{int|apierror-visualeditor-docserver-http|400}}
: <span lang="en" dir="ltr" class="mw-content-ltr">An unresolved error for some users ([[Topic:Wc5hugtg7besmcb2]]).</span>

; {{int|apierror-visualeditor-docserver-http|403}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Caused by the 'writeapi' right being revoked (or not granted).</span> <span lang="en" dir="ltr" class="mw-content-ltr">Check your <code>LocalSettings.php</code> and remove any overrides for this right.</span> ({{T|265043}})

; {{int|apierror-visualeditor-docserver-http|404}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Possible reasons for this problem:</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">Caused by ModSecurity (or possibly another WAF).</span> <span lang="en" dir="ltr" class="mw-content-ltr">Request your hosting service provider to whitelist the security rules that were being triggered by your site.</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">When the web server is Apache, <code>AllowEncodedSlashes NoDecode</code> must be added in the VirtualHost section of the wiki ({{T|261921}}).</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">Possibly Parsoid is not loaded when using default configuration (local Parsoid, no RestBase).</span> <span lang="en" dir="ltr" class="mw-content-ltr">Add to <code>LocalSettings.php</code>: <code>wfLoadExtension( 'Parsoid', 'vendor/wikimedia/parsoid/extension.json' );</code>.</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">Caused by VisualEditor for MW 1.35 and later due to insufficient rewrite rules in case of non-standard short URLs ({{T|T270376}}).</span> <span lang="en" dir="ltr" class="mw-content-ltr">See [[Special:MyLanguage/Extension:VisualEditor/webserver|webserver]] for the solution.</span>

; {{int|apierror-visualeditor-docserver-http|415}}
: <span lang="en" dir="ltr" class="mw-content-ltr">If you're running a private wiki, you might be encountering bug ({{T|268277}}).</span>

; <span lang="en" dir="ltr" class="mw-content-ltr">Error contacting the Parsoid/RESTBase server (HTTP 500) when saving page with accented character in title, on Windows/IIS</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">IIS expects URLs to be encoded using legacy single-byte encodings, but MediaWiki uses UTF-8.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Follow these instructions to resolve this:</span> https://support.microsoft.com/en-us/help/2277918/fix-a-php-application-that-depends-on-the-request-uri-server-variable ({{T|269673}})

; <span lang="en" dir="ltr" class="mw-content-ltr">Error contacting the Parsoid/RESTBase server (HTTP 500) when trying to edit an existing page with VisualEditor</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">Persisting in MW 1.35.x.</span> {{T|270377}} を参照してください。

; {{int|visualeditor-loadwarning|HTTP 500}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Possible reasons for this problem:</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">On new installs, "curl", "php5-curl", or "php7.0-curl" (or other package appropriate to your PHP version) is not installed on the server.</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">setMwApi uri is set incorrectly with e.g. https instead of http.</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">Bad rewrite rules in the apache configuration that would cause API failures.</span>
:* <span lang="en" dir="ltr" class="mw-content-ltr">The SSL/TLS certificates are expired.</span>
:* When directory <code>{{ll|Manual:$wgTmpDirectory|$wgTmpDirectory}}</code> (for example "/tmp") has not write permissions.
:* <span lang="en" dir="ltr" class="mw-content-ltr">When running Windows Authentication with Apache, you would need to white-list 127.0.0.1 in your Apache conf, as Apache doesn't have read access.</span>
<syntaxhighlight lang="apache">
<Directory "D:/Wiki/htdocs">
    ...

    Allow from 127.0.0.1
    Satisfy Any
</Directory>
</syntaxhighlight>

; <span lang="en" dir="ltr" class="mw-content-ltr">No visible error (Appears to load forever)</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">Check the parsoid log file, and consult {{ll|Parsoid/Troubleshooting}}.</span>

; parsoidserver-http-bad-status<nowiki>:</nowiki> 401
: <span lang="en" dir="ltr" class="mw-content-ltr">Caused by read or edit restrictions (aka private wiki).</span> <span lang="en" dir="ltr" class="mw-content-ltr">If you've set up a private wiki and don't want to use cookie forwarding, you can [[User:Andru~mediawikiwiki/Allow Parsoid Server|explicitly remove restrictions for Parsoid by IP address]] (See [[Topic:Vv35plp6g16qno0s]] and the ticket: [[phab:T268277|MW 1.35.0 "Error contacting the Parsoid/RESTBase server: http-bad-status" on a private wiki]]).</span>

; <span lang="en" dir="ltr" class="mw-content-ltr">parsoidserver-http-curl-error<nowiki>:</nowiki> couldn't connect to host.</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">Parsoid is not running, or <syntaxhighlight lang=php inline>$wgVirtualRestConfig['modules']['parsoid']['url']</syntaxhighlight> is not set correctly.</span>

; parsoidserver-http-curl-error<nowiki>:</nowiki> <span lang="en" dir="ltr" class="mw-content-ltr">Failed to connect to ....<nowiki>:</nowiki> Permission denied.</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">Can be caused by a cURL request on a [[:en:Security-Enhanced Linux|Security-Enhanced Linux]] (SELinux, like CentOS) to a non standard port like 8000 in the example configuration above, see http://www.akashif.co.uk/php/curl-error-7-failed-to-connect-to-permission-denied and https://www.centos.org/forums/viewtopic.php?f=47&t=53223&p=225372#p225372.</span>

; parsoidserver-http-not-acceptable<nowiki>:</nowiki> 406
: <span lang="en" dir="ltr" class="mw-content-ltr">Caused by Parsoid 0.9 enforcing clients to return a 1.6.0 and greater HTML version string in the header.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This most likely affects Debian users as they are using slightly older MediaWiki versions with MediaWiki's Parsoid APT repository.</span> <span lang="en" dir="ltr" class="mw-content-ltr">This can be fixed by either downgrading to 0.8 (not easy as 0.8 no longer exists in the repository) or by editing <code>/usr/lib/parsoid/src/lib/config/ParsoidConfig.js</code> so that <code>ParsoidConfig.prototype.strictAcceptCheck = false;</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The latter will be overwritten on any package upgrade, so it is up to the administrator to lock the package and keep on top of updates manually.</span>

; parsoidserver-http-not-found<nowiki>:</nowiki> 404 (<span lang="en" dir="ltr" class="mw-content-ltr">or timeout</span>)
: <span lang="en" dir="ltr" class="mw-content-ltr">Caused by wrong path to MediaWiki API endpoint.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Set correct URL to the right path to <code>api.php</code> in Parsoid's <code>localsettings.js</code> config file.</span> <span lang="en" dir="ltr" class="mw-content-ltr">If you have set up following the recommendations, your API path would be "http://localhost/w/api.php".</span> <span lang="en" dir="ltr" class="mw-content-ltr">Add this API path to "localsettings.js" like "parsoidConfig.setMwApi({uri: 'http://localhost/w/api.php<nowiki/>' });".</span>

== 脚注 ==
<references />

== 開発者の説明文書 ==
* {{ll|VisualEditor/Gadgets}} - <span lang="en" dir="ltr" class="mw-content-ltr">non formal guide for hacking VisualEditor.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Includes code snippets and other information useful to gadget authors (and other custom JS developers).</span>
* [https://doc.wikimedia.org/VisualEditor/master/js/ API の説明文書] - <span lang="en" dir="ltr" class="mw-content-ltr">information on some VisualEditor JS classes.</span>

{{OnWikimedia}}

{{Feedback
| thing = VisualEditor
| author = {{ll|Editing}} team
| irc = mediawiki-visualeditor
| ml = 
| ml2 = 
| phab = visualeditor
}}

[[Category:WYSIWYG extensions{{#translation:}}]]
[[Category:VisualEditor{{#translation:}}]]