• Home
  • More…
  • Archives
  • About…

NUKLEOS weblog

Virtual Memory (Resurrected)

Feeds:
Posts
Comments
« Reading Matter For All, Managers And Programmers Alike
ProseMirror As An Editor (And More) For Your Wiki May Be Coming Soon »

Editing API Versus Markup Standardisation? The Latter Gets My Vote

09/08/2015 by Wouter

Dave asks: should there be “Editing APIs for Wikis?“.

Wikis have been “invented”, to use that word, to make it possible for anyone to edit a Wiki page inside the browser. In a Wiki, content is more important than fancy layouts. Wiki editors thus prescribe a simple markup system for things like ‘bold’ and ‘italic’ lettering, bullet lists, etc. Creole, the attempt to unify dozens of markups, has never been a success. When going from one Wiki to another you may need to adapt your markup automatisms. These markup languages are rather similar, so in practice adaptation from one to another isn’t too hard.

Would it be nice to have a WYSIWYG editor in your Wiki? For some people, the answer is yes. They will indeed be more comfortable with an editor that resembles the editor they use for writing books or letters. But many Wikis allow you to change the editor used for editing Wiki pages. At work, I have activated the FCKEditor (aka. CKEditor) in JSPWiki, and currently our users can still choose the editing style they prefer.

All/most Wikis store the user’s content in their own markup format, not in HTML. The MyWord Editor that Dave Winer has built works differently, if I’m not mistaken: it is a WYSIWYG layer for HTML editing. It should not be too hard to convert the HTML from a simple HTML editor to whatever markup the Wiki uses. But even for a single editor that would require a convertor for multiple Wiki markup dialects.

Yet another Wiki editor: Eclipse and Textile

Yet another Wiki editor: Eclipse/Mylyn and Textile

In the end, the real question is: what would be the added value of such an API?

The purpose of a Wiki is to capture information and not layout. That is why the built-in editors are relatively simple. For hard-core Wiki authors, an HTML textbox plus knowledge of the local markup language will be enough. Occasional authors will have to make do with the built-in MOLWYSIWYG (More Or Less WYSIWYG) editor. I suspect most occasional wiki authors won’t be authoring texts in more than one Wikis, so they will deal with a single variant only.

Would a common API be a good idea? Of course! But such an API would already exist if it served a greater purpose beyond the technical promise of plug-and-play editors.

If you ask me, Wiki’s would be better served with a common markup language like Creole or Markdown or ReST, rather than an editor API. If you think otherwise, then just build such an API. I’ll be happy to write about it!

PS. For a comparison between Creole, Markdown and ReST, check out “Why Markdown Is Not My Favourite Language“…

Share this:

  • Twitter
  • LinkedIn
  • Email

Like this:

Like Loading...

Related

Posted in Software, Web Development, Wiki |

  • My Activity

    August 2015
    M T W T F S S
     12
    3456789
    10111213141516
    17181920212223
    24252627282930
    31  
    « Jul   Sep »
  • My Favourites

    • Ars Technica
    • bvlg.blogspot.com
    • ColdFusion Bloggers
    • Digital Photography Review
    • George Monbiot
    • Heise News Ticker
    • Jamie Todd Rubin
    • Jon Udell
    • Planet Python
    • Scripting.com
    • Seth Gottliebs Blog
    • The Electronic Intifada
  • My Sites

    • Innologos
    • My photos (Flickr)
    • N U K L E O S
  • On Probation

    • Artima Weblogs
    • Ruby Inside
    • The Cult Of Mac
    • The Unofficial Apple Weblog
  • My Categories

    Android Apple & Macintosh ColdFusion Content Management Design and Art Internet Java Linkrot! Linux Literature Mobile Computing Motorcycles Music Patents, IP, Privacy and More PDA Personal Photography Privacy and Security Python R1100S Ruby Science Social Media Society Software Software Development Technology Ubuntu Web Development Wiki
  • My Photos on Flickr

    P1020834P1020823P1020479
    More Photos

Blog at WordPress.com.

WPThemes.


Cancel
loading Cancel
Post was not sent - check your email addresses!
Email check failed, please try again
Sorry, your blog cannot share posts by email.
Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Cookie Policy
%d bloggers like this: