User:WikiMaster/WYSIWYG: Difference between revisions

From PortlandWiki
Jump to navigation Jump to search
(Add resources.)
Line 1: Line 1:
{{RightTOC}}
{{RightTOC}}
== WYSIWYG Research ==
== WYSIWYG Research ==
* [http://www.wired.com/epicenter/2008/12/wikipedias-wysi/ Wikipedia’s WYSIWYG Dilemma]
* [[mediawikiwiki:WYSIWYG editor|WYSIWYG editor]]
: For the more technically inclined, [[metawikipedia:Wiki markup|wiki markup]] is a simple way of formatting a wiki page. However, many would-be users of MediaWiki are put off by what looks to them—rightly—to be code of any sort.  These users are adjusted to publishing and editing in a more visually straightforward '''WYSIWYG''' (''What You See Is What You Get'') environment.
 
* “[http://www.wired.com/epicenter/2008/12/wikipedias-wysi/ Wikipedia’s WYSIWYG Dilemma]” ''(Wired)''
: From Article: (Wikipedia's) editing platform is intentionally designed to be complex so as to lower participation and thus make it easier to manage, and that if they open up the floodgates, "the site will probably come to a grinding halt."
: From Article: (Wikipedia's) editing platform is intentionally designed to be complex so as to lower participation and thus make it easier to manage, and that if they open up the floodgates, "the site will probably come to a grinding halt."


Line 9: Line 12:
; Wikipedia WYSIWYG
; Wikipedia WYSIWYG
* [http://code.grnet.gr/projects/wikipedia-wysiwyg Wikipedia WYSIWYG]
* [http://code.grnet.gr/projects/wikipedia-wysiwyg Wikipedia WYSIWYG]
: [http://code.grnet.gr/projects/wikipedia-wysiwyg/wiki Wikipedia WYSIWYG - wiki]
** [http://code.grnet.gr/projects/wikipedia-wysiwyg/wiki Wikipedia WYSIWYG - wiki]
: Wikipedia WYSIWYG is a collaboration between GRNET and MediaWiki developers. The goal is to provide a better editing interface for Wikipedia. This will be done by evaluating existing approaches and improving them. Read more about the usability testing.<ref>[https://code.grnet.gr/projects/wikipedia-wysiwyg/wiki/Usability_testing Wikipedia WYSIWYG: Usability testing]</ref> The first step is to do usability testing with some of the existing approaches: '''InlineEditor''', '''WYSIFTW''', '''RTE''' and others (see below for details).


=== wikEd ===
=== wikEd ===
* [[wikipedia:User:Cacycle/wikEd|User:Cacycle/wikEd]]
* [[wikipedia:User:Cacycle/wikEd|User:Cacycle/wikEd]]
: '''wikEd''' is a full-featured Wikipedia-integrated advanced text editor for regular to advanced wiki users. '''wikEd''' features [[wikipedia:syntax highlighting|syntax highlighting]] with code check and [[wikipedia:code folding|reference and template folding]], on-page ''Show preview'' and ''Show changes'', and advanced search and replace functions. Please check the [[wikipedia:User:Cacycle/wikEd help|'''wikEd''' help]] page for details. '''wikEd''' works under all web browsers ''except'' [[wikipedia:Internet Explorer|Internet Explorer]] and [[wikipedia:Opera (web browser)|Opera]].
: '''wikEd''' is a full-featured Wikipedia-integrated advanced text editor for regular to advanced wiki users. '''wikEd''' features [[wikipedia:syntax highlighting|syntax highlighting]] with code check and [[wikipedia:code folding|reference and template folding]], on-page ''Show preview'' and ''Show changes'', and advanced search and replace functions. Please check the [[wikipedia:User:Cacycle/wikEd help|'''wikEd''' help]] page for details. '''wikEd''' works under all web browsers ''except'' [[wikipedia:Internet Explorer|Internet Explorer]] and [[wikipedia:Opera (web browser)|Opera]].
 
** [[wikipedia:User:Cacycle/wikEd help|User:Cacycle/wikEd help]]
* [[wikipedia:User:Cacycle/wikEd help|User:Cacycle/wikEd help]]
** [[wikipedia:User:Cacycle/WYSIWYG|User:Cacycle/WYSIWYG]]
 
* [[wikipedia:User:Cacycle/WYSIWYG|User:Cacycle/WYSIWYG]]
: '''This Essay in a Nutshell:''' Pure WYSIWYG is evil. Really. But we can learn a thing or two from it.
: '''This Essay in a Nutshell:''' Pure WYSIWYG is evil. Really. But we can learn a thing or two from it.


=== WYSIWTF (aka WYSIFTW) ===
=== WYSIWTF (aka WYSIFTW) ===
* [[mediawikiwiki:WYSIWYG editor|WYSIWYG editor]]
: For the more technically inclined, [[metawikipedia:Wiki markup|wiki markup]] is a simple way of formatting a wiki page. However, many would-be users of MediaWiki are put off by what looks to them—rightly—to be code of any sort.  These users are adjusted to publishing and editing in a more visually straightforward '''WYSIWYG''' (''What You See Is What You Get'') environment.
* [[mediawikiwiki:WYSIFTW|WYSIFTW]]
* [[mediawikiwiki:WYSIFTW|WYSIFTW]]
: '''WYSIFTW''' (formerly '''WYSIWTF''') is a JavaScript-based tool originally written by [[wikipedia:User:Magnus Manske|Magnus Manske]]. Its primary purpose is to make it easier to edit Wikipedia articles, especially for people unfamiliar with the intricacies of MediaWiki syntax.
: '''WYSIFTW''' (formerly '''WYSIWTF''') is a JavaScript-based tool originally written by [[wikipedia:User:Magnus Manske|Magnus Manske]]. Its primary purpose is to make it easier to edit Wikipedia articles, especially for people unfamiliar with the intricacies of MediaWiki syntax.
: [http://toolserver.org/~magnus/wysiwtf/wysiwtf.js WYSIWTF (aka WYSIFTW)] - The js code.
: [http://toolserver.org/~magnus/wysiwtf/wysiwtf.js WYSIWTF (aka WYSIFTW)] - The js code.
** Demo: Get a user account on Wikipedia (en works best), then add...
<pre>importScriptURI("http://toolserver.org/~magnus/wysiwtf/wysiwtf.js");</pre>
...to your [[Special:MyPage/vector.js]] page.


=== WYSIWYG Extensions ===
=== WYSIWYG Extensions ===
Line 57: Line 59:
# Lack of structure or standardization means that changes to the parser code can unexpectedly change those cases
# Lack of structure or standardization means that changes to the parser code can unexpectedly change those cases
# Combination of edge cases makes round-tripping to HTML and back very hard, which has made it difficult to get rich text editing fully integrated
# Combination of edge cases makes round-tripping to HTML and back very hard, which has made it difficult to get rich text editing fully integrated
== Other Editing Tools ==
* [[mediawikiwiki:Extension:Semantic Forms|Extension:Semantic Forms]]
: Semantic Forms allows you to have '''forms for adding, editing and querying data''' on your wiki, '''without any programming'''. Forms can be created and edited not just by administrators, but by users themselves.


== [[PortlandWiki]] WYSIWYG Discussions ==
== [[PortlandWiki]] WYSIWYG Discussions ==
* [[PortlandWiki]] Search Results: <span class="plainlinks">[http://portlandwiki.org/index.php?title=Special%3ASearch&search=WYSIWYG WYSIWYG]</span>
* [[PortlandWiki]] Search Results: <span class="plainlinks">[http://portlandwiki.org/index.php?title=Special%3ASearch&search=WYSIWYG WYSIWYG]</span>
== References ==
{{Reflist}}

Revision as of 09:49, 22 October 2011

WYSIWYG Research

For the more technically inclined, wiki markup is a simple way of formatting a wiki page. However, many would-be users of MediaWiki are put off by what looks to them—rightly—to be code of any sort. These users are adjusted to publishing and editing in a more visually straightforward WYSIWYG (What You See Is What You Get) environment.
From Article: (Wikipedia's) editing platform is intentionally designed to be complex so as to lower participation and thus make it easier to manage, and that if they open up the floodgates, "the site will probably come to a grinding halt."
WYSIWYM is an acronym for What You See Is What You Mean, and refers to a paradigm for document editing. It is an alternative to the better-known WYSIWYG (what you see is what you get) paradigm, which displays the document on screen as it will be printed.
Wikipedia WYSIWYG
Wikipedia WYSIWYG is a collaboration between GRNET and MediaWiki developers. The goal is to provide a better editing interface for Wikipedia. This will be done by evaluating existing approaches and improving them. Read more about the usability testing.[1] The first step is to do usability testing with some of the existing approaches: InlineEditor, WYSIFTW, RTE and others (see below for details).

wikEd

wikEd is a full-featured Wikipedia-integrated advanced text editor for regular to advanced wiki users. wikEd features syntax highlighting with code check and reference and template folding, on-page Show preview and Show changes, and advanced search and replace functions. Please check the wikEd help page for details. wikEd works under all web browsers except Internet Explorer and Opera.
This Essay in a Nutshell: Pure WYSIWYG is evil. Really. But we can learn a thing or two from it.

WYSIWTF (aka WYSIFTW)

WYSIFTW (formerly WYSIWTF) is a JavaScript-based tool originally written by Magnus Manske. Its primary purpose is to make it easier to edit Wikipedia articles, especially for people unfamiliar with the intricacies of MediaWiki syntax.
WYSIWTF (aka WYSIFTW) - The js code.
    • Demo: Get a user account on Wikipedia (en works best), then add...
importScriptURI("http://toolserver.org/~magnus/wysiwtf/wysiwtf.js");

...to your Special:MyPage/vector.js page.

WYSIWYG Extensions

FCKeditor (Official)
WYSIWYG
The WYSIWYG extension enables a more intuitive editing of pages on a MediaWiki-based site. When this extension is installed, the tab 'Edit' in the command bar on top of every page leads directly in the wysiwyg editing mode. The WYSIWYG extension uses a special version of the CKeditor that outputs wiki text rather than the usual HTML that caused problems for MediaWiki integrations in the past.
RTE (Rich Text Editor (Wikia)
Help:Rich text editor
This extension is enabled by default on Wikia.
svn.wikia-code.com/wikia/trunk/extensions/wikia/RTE
InlineEditor
InlineEditor is an editing interface that allows users to edit and preview elements in the page by clicking them.
Extension:InlineEditor/Proposal
Extension:InlineEditor Demo

Wiki Text / Wiki Markup

MediaWiki's markup syntax has grown organically since 2002, itself based on earlier wiki syntaxes going back to 1995. None of it's very consistent, and there are a lot of edge cases which tend to surprise folks.

  1. Raw markup can look really ugly and intimidating to editors
  2. Tables, templates, tags, etc have many unexpected boundary conditions, which makes some uses of these constructs hard to deal with even for experts
  3. Lack of structure or standardization means that changes to the parser code can unexpectedly change those cases
  4. Combination of edge cases makes round-tripping to HTML and back very hard, which has made it difficult to get rich text editing fully integrated

Other Editing Tools

Semantic Forms allows you to have forms for adding, editing and querying data on your wiki, without any programming. Forms can be created and edited not just by administrators, but by users themselves.

PortlandWiki WYSIWYG Discussions

References