wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-15 18:39:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/extensions/VisualEditor
17751 commits 161 branches 1 tag 190 MiB
JavaScript 88.3%
PHP 7.8%
Less 3.2%
CSS 0.4%
Shell 0.3%
Go to file
Thiemo Kreuz 35080a8646 Better name for ambiguous "empty" concept in the model 
This is really only about the methods name, but doesn't change
any behavior.

I realized we work with several different definitions of what
"empty" means. There are at least two significant definitions:

1. When a parameter's value is the empty string or identical
to the default value, the behavior of the template is the same.
It will use the default value just as if the user entered it.

The auto-value is a meaningful value in this scenario and can't
be considered equal to the empty string.

2. The context here is when the user presses the back button.
This will destroy all user input. But an auto-value is not user
input. It will appear again when the user realizes they made a
mistake. Nothing is lost.

Personally, I would not use the word "empty" to describe this
concept. Things like "containsUserProvidedValue",
"isCustomValue", "isMeaningfulValue", … come to mind. These are
all still a big vague. A "user provided" value can be identical
to the default or auto-value. "Custom" how? I went for
"containsValuableData" for now.

Bug: T274551
Change-Id: I2912a35556795c867a6b2396cbad291e947f0ed6
2021-08-06 15:11:44 +02:00
.jsduck Rename OutlineParameterCheckboxWidget to OutlineParameterCheckboxLayout 2021-06-21 09:08:54 +02:00
.phan Zero-configuration VisualEditor + PHP for MediaWiki LTS 2020-07-13 18:39:08 +00:00
bin updateSubmodule: Put list in topo (merged), not written, order 2018-05-10 08:51:37 -07:00
build Support watchlist expiry 2021-06-08 20:14:45 +00:00
i18n Localisation updates from https://translatewiki.net. 2021-08-02 08:37:43 +02:00
images Merge "Re-crush beta feature SVG screenshots" 2018-02-08 12:18:28 +00:00
includes build: Updating dependencies 2021-07-21 19:56:36 +00:00
lib Update VE core submodule to master (b54bff109) 2021-07-19 23:49:40 +02:00
maintenance Avoid using User::setOption() 2021-03-30 21:47:04 +00:00
modules Better name for ambiguous "empty" concept in the model 2021-08-06 15:11:44 +02:00
screenshots
.eslintrc.json build: Remove max-len over-ride (leave as warning) 2021-06-28 11:30:06 +01:00
.gitignore eslint: Enable caching 2019-02-19 18:53:11 +00:00
.gitmodules .gitmodules: Update gerrit URI syntax, deprecated ages ago, now unsupported 2019-03-19 16:49:03 +00:00
.gitreview
.mailmap Update AUTHORS.txt for the last couple of years' work 2018-01-03 11:51:37 -08:00
.phpcs.xml Fix a series of minor style issues in PHP code 2021-06-03 15:55:38 +02:00
.stylelintrc.json build: Use "Grade A" rules for stylelint 2020-12-01 08:35:03 -08:00
AUTHORS.txt Update principal authors 2020-05-15 20:25:36 +01:00
composer.json build: Updating dependencies 2021-07-21 19:56:36 +00:00
CONTRIBUTING.md doc: Bump copyright year for 2020 2020-01-08 09:13:24 -08:00
extension.json Merge "Add a message next to undocumented parameters" 2021-07-16 12:05:29 +00:00
Gruntfile.js stylelint: Remove needless disables 2020-11-19 23:38:11 +00:00
jsduck.json Update all tests in the ve-mw module to use ES6 syntax 2021-04-30 08:07:54 +00:00
LICENSE.txt doc: Bump copyright year for 2020 2020-01-08 09:13:24 -08:00
package-lock.json build: Updating dependencies 2021-07-21 19:56:36 +00:00
package.json build: Updating npm dependencies 2021-05-07 21:18:30 +00:00
Rakefile build: npm/rake entry point for screenshots upload 2018-03-07 23:23:30 +01:00
README.md Add terminology section to README 2021-06-21 12:39:26 +02:00
VisualEditor.i18n.alias.php doc: Bump copyright year for 2020 2020-01-08 09:13:24 -08:00

README.md

VisualEditor

VisualEditor provides a visual editor for wiki pages. It is written in JavaScript and runs in a web browser.

It uses the Parsoid parser to convert wikitext documents to annotated HTML which the VisualEditor is able to load, modify and emit back to Parsoid at which point it is converted back into wikitext.

For more information about these projects, check out the VisualEditor and Parsoid pages on mediawiki.

Developing and installing

For information on installing VisualEditor on a local wiki, please see https://www.mediawiki.org/wiki/Extension:VisualEditor

For information about running tests and contributing code to VisualEditor, see CONTRIBUTING.md. Patch submissions are reviewed and managed with Gerrit. There is also API documentation available for the VisualEditor.

Terminology