Difference between revisions of "Visual editor"
(Adds References template) |
(continuing to enhance) |
||
| Line 1: | Line 1: | ||
| − | The [http://www.mediawiki.org/wiki/VisualEditor Visual Editor] for MediaWiki relies on the '''Parsoid''' extension <ref>[https://git.wikimedia.org/tree/mediawiki%2Fextensions%2FParsoid Parsoid extension]</ref>. | + | 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 | + | <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> |
| − | 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> | ||
Robin Cover would be proud. It round-trips wiki to HTML and back. | Robin Cover would be proud. It round-trips wiki to HTML and back. | ||
| − | + | == Installation == | |
| + | 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. | ||
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 | 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 | ||
| Line 21: | Line 23: | ||
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. | 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. | ||
| − | == API / Developer | + | To have it run continuously, you might want to use the 'forever' module. |
| + | <source lang="bash"> | ||
| + | npm install forever | ||
| + | </source> | ||
| + | |||
| + | |||
| + | == Extensions == | ||
| + | # [[mw:Extension:VisualEditor]] | ||
| + | # [[mw:Extension:Parsoid]] | ||
| + | |||
| + | == API / Developer Docs / DevOps == | ||
| + | * [[mw:Parsoid/Setup]] | ||
| + | * [[mw:Parsoid/Troubleshooting]] | ||
| + | * [[mw:Parsoid/Debugging]] | ||
| + | * [[mw:Parsoid/Packaging]] | ||
| + | * [https://wikitech.wikimedia.org/wiki/Parsoid DevOps] (Wikitech) | ||
* 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 | ||
Revision as of 14:39, 9 May 2014
The Visual Editor for MediaWiki relies on the Parsoid extension [1] 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 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.
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 forever
Extensions[edit | edit source]
API / Developer Docs / DevOps[edit | edit source]
- mw:Parsoid/Setup
- mw:Parsoid/Troubleshooting
- mw:Parsoid/Debugging
- mw:Parsoid/Packaging
- DevOps (Wikitech)
- https://doc.wikimedia.org/VisualEditor/master/ powered by JSDuck
- http://blog.gmane.org/gmane.science.linguistics.wikipedia.wikitext wikitext-l
I noticed a bug and it was fixed about 5 minutes after I mentioned it! (Thanks C. Scott Ananian)
