Difference between revisions of "Visual editor"

From Freephile Wiki
Jump to navigation Jump to search
VisualWikitext
(Updated for 2023)
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Feature
 
−
|image=Visual Editor (linking).png
 
−
|imgdesc=Direct editing
 
−
|title=
 
−
}}
 
−
{{#set:feature description = A reliable rich-text editor for MediaWiki.  Allows you to just "edit the page you see" while being aware of all the syntactically rich features of templates, extensions etc.}}
 
−
{{#set:feature notes = The Visual Editor is available Here and on Wikipedia.}}
 
−
{{#set:feature tests = [[Special:UserLogin|Login]] to the wiki, and make an edit in your [[Special:MyPage/Sandbox|personal sandbox]]. }}
 
−
{{#set:feature examples = }}
 
−
 
−
 
 
[[File:VisualEditor-logo.svg|alt=Visual Editor|frameless|641x641px|Visual Editor logo]]
 
[[File:VisualEditor-logo.svg|alt=Visual Editor|frameless|641x641px|Visual Editor logo]]
 
== Links ==
 
== Links ==
Line 17: Line 6:
  
 
== Back story ==
 
== Back story ==
−
Wiki markup is a sort of shorthand for more complicated HTML markup designed to create nicely formatted web documents.  Although in the beginning wiki markup simplified the process of creating nicely formatted content, that shorthand can get increasingly complex in order to produce complicated layout and content.  The extension of the markup system over time to include a template subsystem and macros inevitably leads to a tension between ease of use, and power.  This tension was one of the primary factors that the Wikimedia Foundation cited as an impediment to new content collaborators for the Wikipedia. <ref>https://strategy.wikimedia.org/wiki/March_2011_Update</ref><ref>http://strategy.wikimedia.org/wiki/Editor_Trends_Study</ref> <ref>See this October 2013 article in the MIT Technology Review http://www.technologyreview.com/featuredstory/520446/the-decline-of-wikipedia</ref>.  A visual editor was deemed nearly impossible after many early attempts failed, but with the advent of Node.js technology, it became an idea that was plausible again.
+
Wiki markup is a sort of shorthand for more complicated <abbr title="HyperText Markup Language">HTML</abbr> markup designed to create nicely formatted web documents.  Although in the beginning wiki markup simplified the process of creating nicely formatted content, that shorthand can get increasingly complex in order to produce complicated layout and content.  The extension of the markup system over time to include a template subsystem and macros inevitably leads to a tension between ease of use, and power.  This tension was one of the primary factors that the Wikimedia Foundation cited as an impediment to new content collaborators for the Wikipedia. <ref>https://strategy.wikimedia.org/wiki/March_2011_Update</ref><ref>http://strategy.wikimedia.org/wiki/Editor_Trends_Study</ref> <ref>See this October 2013 article in the MIT Technology Review http://www.technologyreview.com/featuredstory/520446/the-decline-of-wikipedia</ref>.  A visual editor was deemed nearly impossible after many early attempts failed, but with the advent of Node.js technology, it became an idea that was plausible again.
−
 
 
−
Fast-forward to 2016 when VisualEditor was fully working as a Visual WYSIWYG interface for editing MediaWiki content, using a Node.js backend called 'Parsoid' which is a bidirectional runtime wiki parser. This caused a big software architectural problem: there were two parsers to maintain: the 'normal' (now 'legacy') core parser in PHP, and the Visual Editor parser (Parsoid) in JavaScript. So, by the end of 2019, Parsoid was ported to PHP, and distributed with MediaWiki 1.35 as part of the [mw:Parsoid/Parser_Unification|Parser Unification initiative]].
 
  
 
== Intro ==
 
== Intro ==
Line 25: Line 12:
 
* [https://www.youtube.com/watch?v=M_Ioi1aLAL8 VIDEO] (47 min.) with James Forrester - Product Manager and Roan Kattouw - Sr. Software Engineer presenting Jan 13, 2014 at Linux.conf.au on the contentEditable aspects of the system.
 
* [https://www.youtube.com/watch?v=M_Ioi1aLAL8 VIDEO] (47 min.) with James Forrester - Product Manager and Roan Kattouw - Sr. Software Engineer presenting Jan 13, 2014 at Linux.conf.au on the contentEditable aspects of the system.
  
−
The [http://www.mediawiki.org/wiki/VisualEditor Visual Editor] for MediaWiki relies on [[mw:Parsoid|Parsoid]]
+
The [http://www.mediawiki.org/wiki/VisualEditor Visual Editor] for MediaWiki relies on the '''[[mw:Extension:Parsoid|Parsoid]]''' extension <ref>[https://git.wikimedia.org/tree/mediawiki%2Fextensions%2FParsoid Parsoid extension]</ref> AND the Parsoid service.  The Parsoid service is a node.js server that interacts with the mediawiki API.
  
 
<blockquote>"Parsoid implements a bidirectional wikitext parser and interpreter. It converts and interprets wikitext into an annotated HTML DOM, which can then be edited with HTML editor tools such as the Visual Editor. It also provides the conversion of a (possibly modified) HTML DOM back to wikitext."</blockquote>
 
<blockquote>"Parsoid implements a bidirectional wikitext parser and interpreter. It converts and interprets wikitext into an annotated HTML DOM, which can then be edited with HTML editor tools such as the Visual Editor. It also provides the conversion of a (possibly modified) HTML DOM back to wikitext."</blockquote>
Line 32: Line 19:
  
 
== Installation ==
 
== Installation ==
−
VisualEditor is included with MediaWiki. See https://www.mediawiki.org/wiki/Extension:VisualEditor
+
You'll need at least [http://www.mediawiki.org/wiki/Release_notes/1.23 MediaWiki v1.23]. I personally run the same [http://www.mediawiki.org/wiki/Special:Version version that they're running on mediawiki.org] (1.24wmf3 [[User:Freephile|greg.rundlett]] ([[User talk:Freephile|talk]]) 19:39, 9 May 2014 (UTC))
 +
=== WebFaction ===
 +
 
 +
To install the Visual Editor extension in a Webfaction account, you need to first have node installed and working.  You can do this by using the [http://docs.webfaction.com/software/custom.html installer in your webfaction panel] and associating a path with the app for a domain.  I chose to install 'node' (which is now it's own one-click install).  Once you do that you can [https://freephile.org/node visit the path] you configured for node and you should see the "hello world" app that the installer puts in place.  You'll need to stop that app, plus remove the cron job that respawns it.  Then, in order to reserve and associate a port for the service, you install another 'app'.  You do not need to open this port in the firewall unless you plan to share it with other instances, since HTTP talks to the node server on the backend.  (I had to export the PORT, but this is no longer necessary if you configure it in localsettings.js <ref><code>parsoidConfig.serverPort = 8080</code> if you are running MediaWiki-Vagrant</ref>.)  Depending on the resource constraints of your hosting package, you may need to limit the number of workers spawned by the Parsoid service.  It calculates a number based on the number of processors.  For a shared hosting account, this is guaranteed to exceed your RAM or CPU limits, so specify the <code>--num-workers</code> option unless you're running on a dedicated host or VM.
 +
 
 +
Follow the installation instructions, and remember to edit both LocalSettings.php and localsettings.js  When you setup the "interwiki" link to point to your API endpoint, you can choose pretty much whatever name you want to give it.  The example is 'localhost'.
 +
 
 +
 
 +
You'll want to set/update your $NODE_PATH and $PATH environment variables to locate the installed node modules, and to find the node and npm binaries
 +
<source lang="bash">
 +
export NODE_PATH="$HOME/webapps/node/lib/node_modules:$NODE_PATH"
 +
echo 'export NODE_PATH="$HOME/webapps/node/lib/node_modules:$NODE_PATH"' >> $HOME/.bashrc
 +
which npm
 +
export PATH="$HOME/webapps/node/bin:$PATH"
 +
echo 'export PATH="/$HOME/webapps/node/bin:$PATH"' >> $HOME/.bashrc
 +
</source>
 +
 
 +
Once node (and npm) is available, you of course need to get the parsoid and visual_editor extensions.  A quick <code>npm install</code> in the parsoid directory sets up all the node machinery.
 +
 
 +
To have it run continuously, you might want to use the 'forever' module:
 +
<source lang="bash">
 +
npm install -g forever
 +
</source>
 +
But that is just a node way of monitoring processes.  You might want to simply use tools built for the purpose like [[tmux]] or [[screen]] plus [[monit]].  If using <code>forever</code>, then you just prefix your call to node with 'forever'
  
 +
At this point you're ready to run the node server.  Note: while installing this, I found a bug which prevented the server from listening on the configured port.  It was awesomely cool that I mentioned the bug in IRC #mediawiki-parsoid and it was fixed before I was done testing my installation!!
  
−
== Extensions ==
+
<source lang="bash">
−
# [[mw:Extension:VisualEditor]]
+
cd ~/webapps/wiki/extensions/Parsoid/
−
# [[mw:Extension:Parsoid]]
+
node api/server.js --num-workers=2 &
 +
</source>
  
−
=== Extensions that hook into VE ===
+
The console should print out a list of worker pids, and the port number that the server is listening on. In your web browser, if you visit that path and port (setup in your WebFaction node mapping), you should see the Parsoid web service API message.
−
* https://codesearch-beta.wmcloud.org/things/?q=ve.ui.commandRegistry.register&files=&excludeFiles=&repos=
 
−
* https://codesearch-beta.wmcloud.org/extensions/?q=VisualEditorPluginModules&i=nope&files=&repos=
 
  
−
Extension authors should register <code>VisualEditorPluginModules</code>
+
There is no stop script for a shared host, but you should be able to do something like
−
# https://www.mediawiki.org/wiki/Extension:Proofread_Page
+
<source lang="bash">
−
# https://www.mediawiki.org/wiki/Extension:CodeMirror (syntax highlighting)
+
for pid in $(/sbin/pidof `which node`); do kill -9 $pid; done
−
# https://www.mediawiki.org/wiki/Extension:Disambiguator
+
</source>
−
# https://www.mediawiki.org/wiki/Extension:Graph
 
−
# https://www.mediawiki.org/wiki/Extension:Kartographer (Open Street Maps)
 
−
# https://www.mediawiki.org/wiki/Extension:LanguageTool
 
−
# https://www.mediawiki.org/wiki/Extension:Math
 
−
# https://www.mediawiki.org/wiki/Extension:Score (LillyPond)
 
−
# https://www.mediawiki.org/wiki/Extension:SyntaxHighlight
 
−
# https://www.mediawiki.org/wiki/Extension:TemplateData
 
−
# https://www.mediawiki.org/wiki/Extension:WikiHiero
 
  
 +
That's because node is installed under your user account, and the $PATH is set as above to find that instance of node.  To be sure that you're not going to kill everyone's node instances, you could look at all the nodes with ps -ef
 +
==== Info ====
 +
* https://docs.webfaction.com/software/nodejs.html
  
−
== Customizing Visual Editor with custom menus, tools, commands ==
+
=== Digital Ocean ===
−
* https://www.mediawiki.org/wiki/VisualEditor/Gadgets
+
*{{@todo}} Install, verify and document process
−
* https://www.mediawiki.org/wiki/VisualEditor/Gadgets/Creating_a_custom_command
 
−
* https://www.mediawiki.org/wiki/VisualEditor/Gadgets/Add_a_tool
 
  
 +
== Extensions ==
 +
# [[mw:Extension:VisualEditor]]
 +
# [[mw:Extension:Parsoid]]
  
 
== API / Developer Docs / DevOps ==
 
== API / Developer Docs / DevOps ==
Line 71: Line 77:
 
* https://doc.wikimedia.org/VisualEditor/master/ powered by JSDuck
 
* https://doc.wikimedia.org/VisualEditor/master/ powered by JSDuck
 
* http://blog.gmane.org/gmane.science.linguistics.wikipedia.wikitext wikitext-l
 
* http://blog.gmane.org/gmane.science.linguistics.wikipedia.wikitext wikitext-l
 +
 +
I [https://gerrit.wikimedia.org/r/#/c/132479/1/api/ParsoidService.js noticed a bug] and it was fixed about 5 minutes after I mentioned it!  (Thanks C. Scott Ananian)
  
 
{{References}}
 
{{References}}

Revision as of 13:03, 23 April 2015

Visual Editor

Links[edit | edit source]

Back story[edit | edit source]

Wiki markup is a sort of shorthand for more complicated HTML markup designed to create nicely formatted web documents. Although in the beginning wiki markup simplified the process of creating nicely formatted content, that shorthand can get increasingly complex in order to produce complicated layout and content. The extension of the markup system over time to include a template subsystem and macros inevitably leads to a tension between ease of use, and power. This tension was one of the primary factors that the Wikimedia Foundation cited as an impediment to new content collaborators for the Wikipedia. [1][2][3]. A visual editor was deemed nearly impossible after many early attempts failed, but with the advent of Node.js technology, it became an idea that was plausible again.

Intro[edit | edit source]

  • VIDEO Wikimania 2013
  • VIDEO (47 min.) with James Forrester - Product Manager and Roan Kattouw - Sr. Software Engineer presenting Jan 13, 2014 at Linux.conf.au on the contentEditable aspects of the system.

The Visual Editor for MediaWiki relies on the Parsoid extension [4] AND the Parsoid service. The Parsoid service is a node.js server that interacts with the mediawiki API.

"Parsoid implements a bidirectional wikitext parser and interpreter. It converts and interprets wikitext into an annotated HTML DOM, which can then be edited with HTML editor tools such as the Visual Editor. It also provides the conversion of a (possibly modified) HTML DOM back to wikitext."

Robin Cover would be proud. It round-trips wiki to HTML + RDFa and back.

Installation[edit | edit source]

You'll need at least MediaWiki v1.23. I personally run the same version that they're running on mediawiki.org (1.24wmf3 greg.rundlett (talk) 19:39, 9 May 2014 (UTC))

WebFaction[edit | edit source]

To install the Visual Editor extension in a Webfaction account, you need to first have node installed and working. You can do this by using the installer in your webfaction panel and associating a path with the app for a domain. I chose to install 'node' (which is now it's own one-click install). Once you do that you can visit the path you configured for node and you should see the "hello world" app that the installer puts in place. You'll need to stop that app, plus remove the cron job that respawns it. Then, in order to reserve and associate a port for the service, you install another 'app'. You do not need to open this port in the firewall unless you plan to share it with other instances, since HTTP talks to the node server on the backend. (I had to export the PORT, but this is no longer necessary if you configure it in localsettings.js [5].) Depending on the resource constraints of your hosting package, you may need to limit the number of workers spawned by the Parsoid service. It calculates a number based on the number of processors. For a shared hosting account, this is guaranteed to exceed your RAM or CPU limits, so specify the --num-workers option unless you're running on a dedicated host or VM.

Follow the installation instructions, and remember to edit both LocalSettings.php and localsettings.js When you setup the "interwiki" link to point to your API endpoint, you can choose pretty much whatever name you want to give it. The example is 'localhost'.


You'll want to set/update your $NODE_PATH and $PATH environment variables to locate the installed node modules, and to find the node and npm binaries 

export NODE_PATH="$HOME/webapps/node/lib/node_modules:$NODE_PATH"
echo 'export NODE_PATH="$HOME/webapps/node/lib/node_modules:$NODE_PATH"' >> $HOME/.bashrc
which npm
export PATH="$HOME/webapps/node/bin:$PATH"
echo 'export PATH="/$HOME/webapps/node/bin:$PATH"' >> $HOME/.bashrc

Once node (and npm) is available, you of course need to get the parsoid and visual_editor extensions. A quick npm install in the parsoid directory sets up all the node machinery.

To have it run continuously, you might want to use the 'forever' module: 

npm install -g forever

But that is just a node way of monitoring processes. You might want to simply use tools built for the purpose like tmux or screen plus monit. If using forever, then you just prefix your call to node with 'forever'

At this point you're ready to run the node server. Note: while installing this, I found a bug which prevented the server from listening on the configured port. It was awesomely cool that I mentioned the bug in IRC #mediawiki-parsoid and it was fixed before I was done testing my installation!! 

cd ~/webapps/wiki/extensions/Parsoid/
node api/server.js --num-workers=2 &

The console should print out a list of worker pids, and the port number that the server is listening on. In your web browser, if you visit that path and port (setup in your WebFaction node mapping), you should see the Parsoid web service API message.

There is no stop script for a shared host, but you should be able to do something like 

for pid in $(/sbin/pidof `which node`); do kill -9 $pid; done

That's because node is installed under your user account, and the $PATH is set as above to find that instance of node. To be sure that you're not going to kill everyone's node instances, you could look at all the nodes with ps -ef

Info[edit | edit source]

Digital Ocean[edit | edit source]

  • Gedit.svg todo Install, verify and document process

Extensions[edit | edit source]

  1. mw:Extension:VisualEditor
  2. mw:Extension:Parsoid

API / Developer Docs / DevOps[edit | edit source]

I noticed a bug and it was fixed about 5 minutes after I mentioned it! (Thanks C. Scott Ananian)

References[edit source]

  1. ↑ https://strategy.wikimedia.org/wiki/March_2011_Update
  2. ↑ http://strategy.wikimedia.org/wiki/Editor_Trends_Study
  3. ↑ See this October 2013 article in the MIT Technology Review http://www.technologyreview.com/featuredstory/520446/the-decline-of-wikipedia
  4. ↑ Parsoid extension
  5. ↑ parsoidConfig.serverPort = 8080 if you are running MediaWiki-Vagrant

HyperText Markup Language = structured text that uses logical links (hyperlinks) between nodes containing text.

Application Programming Interface

HyperText Transfer Protocol = the foundation of data communication for the World Wide Web. See HTML

A worker machine in a Kubernetes cluster.

Retrieved from "https://wiki.freephile.org/wiki/index.php?title=Visual_editor&oldid=5495"